home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 21 / Cream of the Crop 21 (Terry Blount) (October 1996).iso / bbs / qm_bbs.zip / QM-BBS.TXT < prev    next >
Text File  |  1996-07-17  |  13KB  |  273 lines
  1.                          QuoteMagic for BBS Programs
  2.                                 Text Manual
  3.  
  4.    Please read Sections 1.0 and 2.0 for the disclaimer and copyright
  5.    information.
  6.  
  7. ================================= CONTENTS ===================================
  8.  
  9.  1.0  Usage Disclaimer
  10.  2.0  Copyright Notice
  11.       2.1  Distribution Information
  12.  3.0  Installing QuoteMagic
  13.       3.1  Minimum Program Requirements
  14.  4.0  Running QuoteMagic
  15.       4.1  QM-BBS.EXE
  16.       4.2  SETQ.EXE
  17.       4.3  CHECKQ.EXE
  18.  5.0  Limitations of QuoteMagic
  19.  6.0  The Quote List File (QM-QUOTE.LST)
  20.  7.0  Miscellaneous Information
  21.  
  22.  
  23. ========================= 1.0 - USAGE DISCLAIMER =============================
  24.  
  25.    THE AUTHOR OF THIS PROGRAM ACCEPTS NO RESPONSIBILITY FOR DAMAGES
  26.    RESULTING FROM THE USE OF THIS PRODUCT AND MAKES NO WARRANTY OR
  27.    REPRESENTATION, EITHER EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO,
  28.    ANY IMPLIED WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR
  29.    PURPOSE.  THIS SOFTWARE IS PROVIDED "AS IS", AND YOU, ITS USER, ASSUME
  30.    ALL RISKS WHEN USING IT.
  31.  
  32.    IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DAMAGES RESULTING FROM
  33.    THE USE OF THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO, DAMAGES FOR LOSS
  34.    OF BUSINESS PROFITS, BUSINESS INTERRUPTION, LOSS OF DATA OR BUSINESS
  35.    INFORMATION, INCIDENTAL OR CONSEQUENTIAL DAMAGES, OR OTHER FINANCIAL LOSS
  36.    ARISING OUT OF THE USE OF OR INABILITY TO USE THIS PROGRAM, EVEN IF THE
  37.    AUTHOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
  38.  
  39.  
  40. ========================= 2.0 - COPYRIGHT NOTICE =============================
  41.  
  42.    QuoteMagic for BBS Programs is Copyright (c) 1996 by Timothy R. White.
  43.    All Rights Reserved.
  44.  
  45.    All product names referenced herein are trademarks or registered
  46.    trademarks of their respective holders.
  47.  
  48.    2.1 - Distribution Information
  49.    ------------------------------
  50.    You are granted the right to use and to make an unlimited number of
  51.    copies of this software.  You may not disassemble, decompose, reverse
  52.    engineer, or alter this file or any of the other files in this package.
  53.    This includes, but is not limited to, modifying the QM-DOS.EXE file,
  54.    the CHECKQ.EXE file, the SETQ.EXE file, or any of the displays associated
  55.    with these executables.
  56.  
  57.    This software is provided as FREEWARE and cannot be sold.  This
  58.    restriction does not apply to connect time charges, or flat rate
  59.    connection/download fees for electronic bulletin board services.  The
  60.    author encourages you to use these methods to distribute the
  61.    QuoteMagic package.  This software can not be bundled with any commercial
  62.    package without express written permission from the author.
  63.  
  64.  
  65.    2.2 - Registration Information
  66.    ------------------------------
  67.    Since QuoteMagic is freeware, no registration fee is required and it
  68.    is already fully functional.  If you are interested in obtaining the
  69.    C++ source code for QuoteMagic, it is available for a nominal fee.
  70.    Contact the author at the E-mail address listed in Section 7.0 of
  71.    this manual for further information.
  72.  
  73.    QM-DOS and QM-BBS are written with Turbo C++ 3.0 for DOS under Windows
  74.    95.  QM-WIN16 and QM-WIN32 are written with Borland C++ 5.0 under Windows
  75.    95.
  76.  
  77.  
  78. ====================== 3.0 - INSTALLING QUOTEMAGIC ===========================
  79.  
  80.    Installing QuoteMagic for BBS Programs is very simple.  First, create
  81.    a directory for the files on your hard drive (it can be called anything,
  82.    and placed wherever you please).  Copy all the files from the
  83.    QM-BBS.ZIP archive into this directory (or, better yet, unzip it into
  84.    the new directory).  QuoteMagic includes a default QM-BBS.DAT file
  85.    which should work fine on most systems.  The default date in this file
  86.    is 01/01.  If you are installing it on January 1st (doesn't matter
  87.    which year), use SETQ.EXE to set a different date (see Section 4.2).
  88.  
  89.    The hardest part about setting up QuoteMagic is getting the files it
  90.    generates (QUOTE.ANS and QUOTE.TXT) copied/moved into the files you
  91.    need to display to your users.  This has only been tested on an RBBS
  92.    bulletin board system, so I can't really give you many directions as
  93.    to what to do.  Take a look at the QM-QUOTE.BAT file for an example
  94.    of what the sysop does on my local RBBS board.  Basically, he uses
  95.    the files QuoteMagic generates as a "welcome" message for the users.
  96.    I wrote up a simple "Page Break" text file which he appends onto
  97.    the WELCOME and WELCOMEC files as they are having the QUOTE.ANS and
  98.    QUOTE.TXT files copied into them.  Works great for RBBS (and with
  99.    the Page Break, the quote won't just fly by--the user actually has
  100.    to press <Enter> to continue past it).
  101.  
  102.    3.1  Minimum Program Requirements
  103.    ---------------------------------
  104.    QuoteMagic for BBS Programs will occupy roughly 200K on your hard
  105.    drive (this can vary based on the size of the QM-QUOTE.LST file).  It
  106.    requires approximately 250K of free DOS conventional memory to run.
  107.    You will also need DOS 3.3 or higher, but if you don't have that,
  108.    QuoteMagic isn't going to be your only problem...
  109.  
  110.    The BBS version of QuoteMagic has been designed for generating quote
  111.    files for use by any BBS.  However, this is not its only possibility.
  112.    There could be many other uses for the QUOTE.ANS and QUOTE.TXT files.
  113.    I'll leave it up to you to adapt for your own purposes.
  114.  
  115.  
  116. ======================= 4.0 - RUNNING QUOTEMAGIC =============================
  117.  
  118.    QuoteMagic for BBS Programs is a rather simple program that generates
  119.    a new quote from a predefined list either daily or each time it is run.
  120.    The new quote is written to two different files:  QUOTE.ANS, a full color
  121.    ANSI text file with high-order ASCII characters; and QUOTE.TXT, a
  122.    one-color text file with NO high-order ASCII characters.
  123.  
  124.    QuoteMagic pulls its quotes from the QM-QUOTE.LST file.  This file
  125.    is in simple ASCII format and can be edited with any text editor.
  126.    You can have up to 9,999 different quotes in this file.
  127.  
  128.    QuoteMagic stores the your current quote information (Quote ID Number,
  129.    Day, Month, and Execution Option) in the QM-BBS.DAT file.  This file is
  130.    in binary format and can not be changed except with the provided editors
  131.    (see below).
  132.  
  133.    4.1 - QM-BBS.EXE
  134.    ----------------
  135.    This is the main program executable.  You *MUST* specify the directory
  136.    that QuoteMagic has been installed to on the command line.  For
  137.    example:
  138.  
  139.        C:\>C:\QM\QM-BBS C:\QM
  140.  
  141.    If you do not specify the directory on the command line, QuoteMagic
  142.    will generate a DOS ErrorLevel 1 and give you a message indicating the
  143.    format you must use.
  144.  
  145.    If QuoteMagic has an error during execution, it will pass a message
  146.    along to you stating what's wrong, and generate a DOS ErrorLevel
  147.    value.  The possible ErrorLevels are:
  148.  
  149.         1 - No directory specified on the command line.
  150.         2 - Could not write the QUOTE.TXT file to the directory specified
  151.             on the command line.
  152.         3 - Could not write the QUOTE.ANS file to the directory specified
  153.             on the command line.
  154.         4 - Could not open the QM-QUOTE.LST file in the directory
  155.             specified on the command line.
  156.         5 - Could not write the updated QM-BBS.DAT file to the directory
  157.             specified on the command line.
  158.  
  159.    Once run, you will find the QUOTE.ANS and the QUOTE.TXT files in your
  160.    QuoteMagic directory (whatever you specified on the command line).
  161.    You can then move/copy these files wherever you need them.
  162.  
  163.    4.2 - SETQ.EXE
  164.    --------------
  165.    This simple program can be used to manually change the options in the
  166.    QM-BBS.DAT file.  It allows you to change the current Quote ID Number,
  167.    the current Quote Date, the current Quote Month, and the Program
  168.    Execution option.  The program is self-explanatory.  Run it and it will
  169.    prompt you for what it needs.
  170.  
  171.    NOTE:  MAKE SURE YOU RUN SETQ.EXE FROM THE MAIN QUOTEMAGIC DIRECTORY.
  172.           IT *WILL NOT* FUNCTION COR